Transaction Request Header Fields

The transaction request header contains optional fields. This table provides a description of each optional field and how the data is used.

Field Name	Description	Usage
Site Trace	Allows a client to provide a value that can be searched for later. Clients are free to provide any value that is useful to them but it must not contain sensitive data. Echoed in the response if present	Stored in Portico; not passed to host
DeveloperId	Identifier assigned by Heartland during the certification process. Optional to support legacy integrations. Required for all new Heartland integrations.	Stored in Portico; not passed to host
VersionNbr	Software version number assigned by Heartland during the certification process. Optional to support legacy integrations. Required for all new Heartland integrations.	Stored in Portico; not passed to host
OptionalPOSData	Required for Canadian merchants; see your certification analyst for details.	Stored in Portico; not passed to host
ClientTxnId	A client-generated transaction id. This must be unique for this device. Echoed in the response. Can be used to initiate a reversal in the event of a timeout. See Also: Client Txn Id.	Stored in Portico; not passed to host
UniqueDeviceId	A client-supplied device identifier to be sent when transactions for multiple devices are aggregated in the same batch. Echoed in the response header.	Stored in Portico; if present, the field will be sent to the host, and passed to the issuer, on authorization and settlement requests. Supported for the Exchange and GSAP-NA authorization platforms.
SAFData>SAFIndicator	Indicates whether a transaction was initiated in "store and forward" (SAF) mode. See Also: Store and Forward	Stored in Portico; if present, sets appropriate indicators in the host request message which are also passed on to the issuer. Supported for the Exchange and GSAP-NA authorization platforms.
SAFData>SAFOrigDT	Date and time when the transaction was originally initiated.	Stored in Portico; if present, sets appropriate indicators in the host request message which are also passed on to the issuer. Supported for the Exchange and GSAP-NA authorization platforms.
PosReqDT	POS request date and time. Required for Interac processing. Required for Canadian merchants.	Stored in Portico; if present, passed to the host for Canadian merchants. Supported for the GSAP-NA authorization platform only.
DeviceConfiguration>Capabilities	Capabilities for a Device	Stored in Portico; if present, passed to the host for UK merchants. Supported for the GNAP-UK authorization platform only.
DeviceConfiguration>Attributes	Attributes for a Device	Stored in Portico; if present, passed to the host for UK merchants. Supported for the GNAP-UK authorization platform only.
DeviceConfiguration>SerialNbr	Serial number of PIN pad or PIN entry device (PED). Required for Interac debit services in Canada.	Stored in Portico; if present, passed to the host for Canadian merchants. Supported for the GSAP-NA authorization platform only.
DeviceConfiguration>TxnMCC	MCC value that is passed from POS. Overrides MCC value stored for the DeviceId. Usage is restricted.	Stored in Portico; if present, passed to the host. Supported for the GSAP-NA and GSAP-AP authorization platforms.
UPIAuthNetwork	Indicates the authorization network to be used for co-branded UnionPay cards, based on cardholder choice at the Point of Sale.	Stored in Portico; if true, authorizations will route to the UnionPay network. Supported for GNAP-UK merchants only.
SDKNameVersion	Name and Version of the SDK used for integration, where applicable. Expected for users of the Heartland SDK.	Stored in Portico; not passed to host Included in ReportTxnDetail responses if populated.